ODWindowIterator

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods

ODWindowIterator

Superclasses
ODObject
Subclasses
none

An object of the ODWindowIterator class provides access to all windows of the window-state object.

Description
You use a window iterator to apply an operation to all windows of all open drafts of the current session's document. For example, a root part might use a window iterator to tile all the currently open windows. A window iterator maintains a reference to its window-state object and to the current window object. The internal list of windows in the window-state object is ordered by creation time and is not related to front-to-back ordering of the windows.
Your part creates a window iterator object by calling the window-state object's CreateWindowIterator method (page 859), which returns a reference to a window iterator object.
While you are using a window iterator, you should not modify the list of open windows. You must postpone adding windows to or removing windows from the list of open windows until after you have deleted the iterator.
For more information related to the window-state object, see the ODWindowState class description (page 846). For more information on accessing objects through iterators, see "Accessing Objects Through Iterators" on page 473 in OpenDoc Programmer's Guide.

Methods
This section presents summary descriptions of the ODWindowIterator methods grouped according to purpose, followed by detailed descriptions in alphabetical order.
Accessing

First
Begins the iteration and returns a reference to the first window in the window state.
Last
Begins the iteration and returns a reference to the last window in the window state.
Next
Returns a reference to the next window in the window state.
Previous
Returns a reference to the previous window in the window state.
Iterator Testing

IsNotComplete
Returns a Boolean value that indicates whether the iteration is incomplete.

Methods
First
IsNotComplete
Last
Next
Previous